home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Applications 1999 May / SGI IRIX 6.5 Applications 1999 May.iso / dist / insight.idb / usr / share / catman / u_man / cat1 / sgihelp.z / sgihelp
Encoding:
Text File  |  1998-05-04  |  9.2 KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSGGGGIIIIHHHHEEEELLLLPPPP((((1111))))                                                          SSSSGGGGIIIIHHHHEEEELLLLPPPP((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      sgihelp - The Silicon Graphics Help Viewer
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      sgihelp [ -debug ] [ -nofork ]
  13.  
  14.      sgihelp -app aaaapppppppp____ccccllllaaaassssssssnnnnaaaammmmeeee -c index [ -l lllliiiibbbb____ppppaaaatttthhhh ] [ -debug ] [ -nofork ]
  15.  
  16.      sgihelp -b bbbbooooooookkkk____nnnnaaaammmmeeee -k hhhheeeellllpppp____kkkkeeeeyyyy [ -app aaaapppppppp____ccccllllaaaassssssssnnnnaaaammmmeeee ]
  17.                 [ -l lllliiiibbbb____ppppaaaatttthhhh ] [ -debug ] [ -nofork ] [ -m uuuusssseeeerrrr____ddddaaaattttaaaa ] ]
  18.  
  19.  
  20. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  21.      _s_g_i_h_e_l_p is an online help viewer. This viewer provides an easy-to-use
  22.      interface which allows the user to browse through help information that
  23.      is distributed from _S_i_l_i_c_o_n _G_r_a_p_h_i_c_s.
  24.  
  25.      ssssggggiiiihhhheeeellllpppp is based on the iiiinnnnssssiiiigggghhhhtttt(1) on-line viewing technology.  The
  26.      content for the help information that is displayed is derived from the
  27.      iiiinnnnssssiiiigggghhhhtttt(1) books.
  28.  
  29.      ssssggggiiiihhhheeeellllpppp is an application that gets started only when a request is made
  30.      for "help". A user should _n_e_v_e_r have to start sgihelp from the command-
  31.      line, unless it is used to generate a help request through a combination
  32.      of the command-line arguments described below.  Requests can be generated
  33.      from:
  34.  
  35.           o  Help menu item(s) found within an application
  36.           o  A help pushbutton on an application window
  37.           o  An application sending a request directly
  38.           o  SGIHelp itself
  39.  
  40.      ssssggggiiiihhhheeeellllpppp renders the request, if the help content is available (see
  41.      "FFFFIIIILLLLEEEESSSS" below).
  42.  
  43.      The ssssggggiiiihhhheeeellllpppp window is composed of two panes (areas): the Viewer pane and
  44.      the Contents/Search pane. For further information, consult the ssssggggiiiihhhheeeellllpppp
  45.      on-line help.
  46.  
  47.      After the user closes all ssssggggiiiihhhheeeellllpppp windows, ssssggggiiiihhhheeeellllpppp sits in the background
  48.      process queue waiting for another request (note that this is nnnnooootttt the case
  49.      if "Exit" is chosen from the ssssggggiiiihhhheeeellllpppp "Session" menu, this anomaly takes
  50.      place only if "Close" is done). If no activity occurs for 4 minutes
  51.      (default), ssssggggiiiihhhheeeellllpppp gracefully exits.  Note that the "4 minutes" is a
  52.      configurable number which a user could change in the application defaults
  53.      file (see "FFFFIIIILLLLEEEESSSS" below), or override in a local .Xdefaults file. The
  54.      resource is called _T_i_m_e_o_u_t_I_n_M_i_n. For example, the following sets the
  55.      resource down to one minute and would go into a local .Xdefaults file:
  56.  
  57.      SSSSGGGGIIIIHHHHeeeellllpppp****TTTTiiiimmmmeeeeoooouuuuttttIIIInnnnMMMMiiiinnnn:::: 1111
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSGGGGIIIIHHHHEEEELLLLPPPP((((1111))))                                                          SSSSGGGGIIIIHHHHEEEELLLLPPPP((((1111))))
  71.  
  72.  
  73.  
  74. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  75.      -app The -app aaaapppppppp____ccccllllaaaassssssssnnnnaaaammmmeeee options tells _s_g_i_h_e_l_p to process a help
  76.           request for the given application. The aaaapppppppp____ccccllllaaaassssssssnnnnaaaammmmeeee coincides with
  77.           an associated help file that can be found in (default)
  78.           /_u_s_r/_s_h_a_r_e/_h_e_l_p or it can be the same as the name used for the
  79.           application's defaults file, found in /_u_s_r/_l_i_b/_X_1_1/_a_p_p-_d_e_f_a_u_l_t_s.
  80.  
  81.      -b   The -b bbbbooooooookkkk____nnnnaaaammmmeeee option tells _s_g_i_h_e_l_p to examine the specified book
  82.           for help content for the given request.  The bbbbooooooookkkk____nnnnaaaammmmeeee is the
  83.           abbreviated short title for the book.  Note that this option is
  84.           case-sensitive. For example:
  85.  
  86.           ssssggggiiiihhhheeeellllpppp ----bbbb IIIIRRRRIIIISSSSEEEEsssssssseeeennnnttttiiiiaaaallllssss ............
  87.  
  88.      -k   The -k hhhheeeellllpppp____kkkkeeeeyyyy option tells _s_g_i_h_e_l_p to render the help card that
  89.           has a specified "HelpId=" attribute of hhhheeeellllpppp____kkkkeeeeyyyy.
  90.  
  91.      -c   The -c command option is used to invoke _s_g_i_h_e_l_p and open the
  92.           Contents/Search area for the designated aaaapppppppp____ccccllllaaaassssssssnnnnaaaammmmeeee.  You must
  93.           specify iiiinnnnddddeeeexxxx as the parameter following this option; which is an
  94.           artifact of an older version of ssssggggiiiihhhheeeellllpppp.
  95.  
  96.           For example, the command used for opening ssssggggiiiihhhheeeellllpppp and loading the
  97.           available help information for the _i_n_s_i_g_h_t application would be:
  98.  
  99.           ssssggggiiiihhhheeeellllpppp ----aaaapppppppp IIIInnnnssssiiiigggghhhhtttt ----cccc iiiinnnnddddeeeexxxx
  100.  
  101.      -debug
  102.           Tells _s_g_i_h_e_l_p to print messages it is receiving to stdout.
  103.  
  104.      -nofork
  105.           The -nofork (or -f) option tells _s_g_i_h_e_l_p to run in the foreground.
  106.           The default is to automatically background when starting.
  107.  
  108.      -l   The -l lllliiiibbbb____ppppaaaatttthhhh option tells _s_g_i_h_e_l_p to load the specified IRIS
  109.           InSight library.  A library is defined as a collection of
  110.           bookshelves. By default, the library is rooted at
  111.           /_u_s_r/_s_h_a_r_e/_I_n_s_i_g_h_t/_l_i_b_r_a_r_y. The path (relative or full) to the new
  112.           library should be specified.  Only one library may be specified. For
  113.           example:
  114.  
  115.           ssssggggiiiihhhheeeellllpppp ----llll ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbb____XXXXXXXXXXXX ............
  116.  
  117.           Another method for specifying the designated library is to set the
  118.           resource, "_d_e_f_L_i_b_P_a_t_h". The resource value should be designated in
  119.           the same manner as was described for _T_i_m_e_o_u_t_I_n_M_i_n. For example:
  120.  
  121.           SSSSGGGGIIIIHHHHeeeellllpppp****ddddeeeeffffLLLLiiiibbbbPPPPaaaatttthhhh:::: ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbb____XXXXXXXXXXXX
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSGGGGIIIIHHHHEEEELLLLPPPP((((1111))))                                                          SSSSGGGGIIIIHHHHEEEELLLLPPPP((((1111))))
  137.  
  138.  
  139.  
  140.      -m   The -m uuuusssseeeerrrr____ddddaaaattttaaaa option is used to pass data to _s_g_i_h_e_l_p and is
  141.           currently only used by the System Monitor; see ssssyyyyssssmmmmoooonnnn((((1111mmmm)))).
  142.  
  143. FFFFIIIILLLLEEEESSSS
  144.      /usr/sbin/sgihelp, /usr/lib/X11/app-defaults/SGIHelp
  145.  
  146.      Help content for the IRIX Interactive Desktop(TM) is retrieved from the
  147.      following sample of book subsystems (subject to change):
  148.  
  149.      desktop_eoe.books.*     IRIX Interactive Desktop(TM) Books
  150.      dmedia_eoe.books.*      Digital Media Tools User's Guide, Help
  151.      eoe.books.*             IRIX Execution Environment Books
  152.      imgtools.books.*        ImageVision Tools User's Guide, Help
  153.      impr_base.books.*       Impressario User's Guide
  154.      sysmon.books.*          Desktop System Monitor Help
  155.      *.books.[Hh]elp         Various Help-related books
  156.  
  157.  
  158. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  159.      _i_n_s_i_g_h_t(_1)
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.                                                                         PPPPaaaaggggeeee 3333
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.